/*
 * Copyright 2013-2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.awspring.cloud.autoconfigure.core;

import java.net.URI;
import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
import org.springframework.lang.Nullable;

/**
 * Details required to establish a connection to a AWS.
 *
 * @author Maciej Walkowiak
 * @since 3.2.0
 */
public interface AwsConnectionDetails extends ConnectionDetails {

	/**
	 * AWS or Localstack endpoint.
	 *
	 * @return the AWS or Localstack endpoint or {@code null}
	 */
	@Nullable
	default URI getEndpoint() {
		return null;
	}

	/**
	 * AWS or Localstack region.
	 *
	 * @return the AWS or Localstack region or {@code null}
	 */
	@Nullable
	default String getRegion() {
		return null;
	}

	/**
	 * Credentials Access Key.
	 *
	 * @return the access key
	 */
	default String getAccessKey() {
		return null;
	}

	/**
	 * Credentials Secret Key
	 *
	 * @return the secret key
	 */
	default String getSecretKey() {
		return null;
	}
}
